/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.core.api;

/**
 * Defines a way to generate cache keys for {@link Event} instances.
 */
public interface MuleEventKeyGenerator {

  /**
   * Generates a key for an event.
   * <p/>
   * The generation algorithm should return the same key value for all the events that are considered equals.
   *
   * @param event the event to generate the key for
   * @return the generated key
   * @throws IllegalStateException if the generated key is not a String
   */
  String generateKey(Event event);
}
